Skip to content

Update arg lists for 2 events in event_callbacks.rst #13516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 21, 2025

Conversation

vwheeler63
Copy link
Contributor

Purpose

Documentation in ./doc/extdev/event_callbacks.rst showed 2 events with an old (or incomplete) list of arguments in the "Core events overview" section, specifically their leading app argument. This was remedied.

References

  • Python/Lib/site-packages/sphinx/domains/std/init.py line 1443 function:
    def warn_missing_reference(
        app: Sphinx,
        domain: Domain,
        node: pending_xref,
    ) -> bool | None:
        ...
  • Python/Lib/site-packages/sphinx/ext/intersphinx/_resolve.py line 339 function:
    def missing_reference(
        app: Sphinx, env: BuildEnvironment, node: pending_xref, contnode: TextElement
    ) -> nodes.reference | None:
        """Attempt to resolve a missing reference via intersphinx references."""
        return resolve_reference_detect_inventory(env, node, contnode)

@AA-Turner AA-Turner changed the title docs(event_callbacks.rst): updated arg lists for 2 events Update arg lists for 2 events in event_callbacks.rst May 20, 2025
@AA-Turner AA-Turner merged commit ad360fd into sphinx-doc:master May 21, 2025
7 checks passed
@vwheeler63 vwheeler63 deleted the docs/update_event_arg_lists branch May 21, 2025 01:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants